API Documentation
Public Member Functions | List of all members
nkGraphics::Pass Class Referenceabstract

The base for a pass within a TargetOperations.
More...

Inheritance diagram for nkGraphics::Pass:
nkGraphics::ProfilableClass nkExport::Exportable nkGraphics::ClearTargetsPass nkGraphics::ComputePass nkGraphics::InstancingPass nkGraphics::PostProcessPass nkGraphics::RaytracingPass nkGraphics::RenderScenePass nkGraphics::MonoMaterialPass

Public Member Functions

 Pass ()
 
virtual ~Pass ()
 
TargetOperationsgetParent () const
 
PASS_TYPE getType () const
 
nkMemory::StringView getName () const
 
void setParent (TargetOperations *parent)
 
void setName (const nkMemory::StringView &name)
 
virtual void render ()=0
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
virtual void importClassFromTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Detailed Description

The base for a pass within a TargetOperations.

One pass is attached to one target operations, which owns it.
See TargetOperations for all the passes available.

Constructor & Destructor Documentation

◆ Pass()

nkGraphics::Pass::Pass ( )

Default constructor. A pass is allocated through the TargetOperations it should work in.

◆ ~Pass()

virtual nkGraphics::Pass::~Pass ( )
virtual

Destructor. A pass should be freed through the TargetOperations it works in.

Member Function Documentation

◆ getParent()

TargetOperations* nkGraphics::Pass::getParent ( ) const
Returns
The parent target operations.

◆ getType()

PASS_TYPE nkGraphics::Pass::getType ( ) const
Returns
The pass type.

◆ getName()

nkMemory::StringView nkGraphics::Pass::getName ( ) const
Returns
The name of the pass.

◆ setParent()

void nkGraphics::Pass::setParent ( TargetOperations parent)

Sets the parent target operations.

Parameters
parentThe parent to set.

◆ setName()

void nkGraphics::Pass::setName ( const nkMemory::StringView name)

Sets the name of the pass.

Parameters
nameThe name to assign.

◆ render()

virtual void nkGraphics::Pass::render ( )
pure virtual

Part of old API. Will be removed in a near future.

◆ exportClassToTree()

virtual void nkGraphics::Pass::exportClassToTree ( nkExport::Node rootNode)
overridevirtual

◆ importClassFromTree()

virtual void nkGraphics::Pass::importClassFromTree ( nkExport::Node rootNode)
overridevirtual

The documentation for this class was generated from the following file: